Button-Toggle Settings

Description

The Button-Toggle Settings allow you to specify various aspects of the button-toggle item; such as whether the button-toggle will switch between two buttons (Two State) or more than two buttons (Multi-state) when a user clicks on it. These settings also allow for the definition of a 'Data variable'. This can be used as a hook that enables the button-toggle to interact with other controls, like a list control.

Name
Description
Type

The 'type' property determines whether the button is a two-state or multi-state toggle. If you select multi-state a builder is available to define the different states.

Multi-state Settings

Multi-state Toggles can be defined by setting the type to Multi-state and then click the smart field for the builder.

Keep pressed

Show the button in its pressed state after the user had stopped pressing on the icon.

Data variable

Specify the name of the variable in the ControlBar's data object that will be set when the button state is toggled.

Initial state

For a two-state toggle, this is true or false, For a multi-state toggle, this is a 0 based number indicating which state should initially be selected.

Show expression

Enter an expression. If the expression is true or empty, the Button will be shown.

Disabled expression

Enter an expression. If the expression is true or empty, the Button will be shown.

Auto-hide disclosure

Specify if the currently open Disclosure (if any) should be closed when a button is tapped. If 'auto' then uses the 'autoHide' property defined on the 'disclosure-button' or in the .showDiclosure() method.